• All about dedications in books (This week in books)

    Updated: 2024-10-15 20:27:20
    This week! Books! First up, I’m taking an early fall blog break over the next few weeks and will be back posting in October. As always, I’ll still be answering emails and scheduling edits and coaching sessions, so feel free to reach out if I can be helpful. Sophie Masson has a cool post on […]

  • Two days in my life as a technical writer, followed by reflection and analysis of fragmenting microtasks

    Updated: 2024-10-15 20:27:15
    , , Blog Podcast API doc course Course home Chapter 1 : Introduction to REST APIs Chapter 2 : Using an API like a developer Chapter 3 : Documenting API endpoints Chapter 4 : OpenAPI spec and generated reference docs Chapter 5 : Step-by-step OpenAPI code tutorial Chapter 6 : Testing API docs Chapter 7 : Conceptual topics in API docs Chapter 8 : Code tutorials Chapter 9 : The writing process Chapter 10 : Publishing API docs Chapter 11 : Publishing tools and workflows Chapter 12 : Thriving in the API doc space Chapter 13 : Native library APIs Chapter 14 : Processes and methodology Chapter 15 : Metrics and measurement Chapter 16 : Glossary Chapter 17 : Additional resources Shop PDFs available TW AI Use cases for AI Prompt engineering for TW scenarios AI category posts Series Rereading Zen and

  • Using AI to jump-start code samples

    Updated: 2024-10-15 20:27:15
    In this article, I provide a strategy for one of the most challenging topics in prompt engineering with docs: using AI to help with code samples. At the extreme end, this could mean using AI to generate code samples from documentation; at the other end, it could mean describing code that’s already been written. My approach is more of a hybrid between the two. After describing a typical scenario, I explore the difference between test code and application code and why engineers are reluctant to provide code samples in documentation.

  • Connective tissue is wildly underrated in storytelling

    Updated: 2024-10-14 20:59:02
    One of the things that has always mystified me about using A.I. for fiction is that the services often promise to dispense with drudgery to help you focus on the “big stuff.” What, pray tell, is the “big stuff” exactly? Sure, some scenes mark turning points and fulcrums in the overall narrative. Some are more […]

  • Han Kang wins the Nobel in literature (This week in books)

    Updated: 2024-10-11 19:00:00
    This week! Books! I collected a whole load of links over the past few weeks, so many that I am going to revert to providing the links with limited commentary. (Do you actually prefer this approach? Should I do this more? Let me know in the comments!) Han Kang Is Awarded Nobel Prize in Literature […]

  • Where do you spend time online?

    Updated: 2024-10-09 19:00:00
    With social media fragmenting, I’m bringing back my old “You Tell Me” Wednesday discussions to try to get good old fashioned blog conversations going. If you’re reading in a feed reader or via email, please click through to the post to leave a public comment and join the discussion! There’s so much pressure on authors to be […]

  • Candles in the dark

    Updated: 2024-10-07 22:04:53
    One of the earliest lessons we are taught as children is that two wrongs don’t make a right. Just because your sister hit you doesn’t mean you get to hit her back. Just because your brother overturned the Monopoly board doesn’t mean you get to break something on his desk. When we get older, we […]

  • NotebookLM podcasts -- the missing piece in the GenAI puzzle?

    Updated: 2024-10-06 07:00:00
    NotebookLM can automatically generate podcasts about any content you provide. In exploring these podcasts this week, I think they might complete a piece that was missing from the GenAI picture with tech comm: these podcasts can help you understand and learn the content you're working on, even when other AI techniques might shortcut that learning.

  • [Podcast] GenAI and Document360: Conversation with Saravana Kumar

    Updated: 2024-10-06 07:00:00
    This podcast explores GenAI in technical documentation scenarios, highlighting the AI features and capabilities provided in Document360. I talk with Saravana Kumar, CEO of Kovai.co, which makes Document360, about how AI is changing search functionality and reducing support costs in knowledge bases. We discuss practical applications of AI for technical writers, including automated tagging, SEO optimization, glossary creation, and more. Saravana shares about AI agent workflows, conversational search experiences, automating screenshot captures, and much more.

Current Feed Items | Previous Months Items

Sep 2024 | Aug 2024 | Jul 2024 | Jun 2024 | May 2024 | Apr 2024